textbuffer: Add some docs for undo
authorMatthias Clasen <mclasen@redhat.com>
Wed, 26 May 2021 18:20:39 +0000 (14:20 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 26 May 2021 18:36:16 +0000 (14:36 -0400)
Mention what is undoable and what isn't.

gtk/gtktextbuffer.c

index d54f72e338ae2840a329fe3fe7cd536dbd5b0f75..473e3e3deb3851aa1f3ac052911ce209275b6aac 100644 (file)
@@ -49,6 +49,9 @@
  * [text widget conceptual overview](section-text-widget.html),
  * which gives an overview of all the objects and data types
  * related to the text widget and how they work together.
+ *
+ * GtkTextBuffer can support undoing changes to the buffer
+ * content, see [method@Gtk.TextBuffer.set_enable_undo].
  */
 
 typedef struct _GtkTextLogAttrCache GtkTextLogAttrCache;
@@ -4983,6 +4986,9 @@ gtk_text_buffer_get_enable_undo (GtkTextBuffer *buffer)
  *
  * Sets whether or not to enable undoable actions in the text buffer.
  *
+ * Undoable actions in this context are changes to the text content of
+ * the buffer. Changes to tags and marks are not tracked.
+ *
  * If enabled, the user will be able to undo the last number of actions
  * up to [method@Gtk.TextBuffer.get_max_undo_levels].
  *